Syntax

Visual Basic (Declaration)
Overloads Public Function Run( _ ByVal form As RasterImage, _ ByVal pageRequestCallback As PageRequestCallback, _ ByVal userData As Object, _ ByVal categories As List(Of IMasterFormsCategory) _ ) As AutoFormsRunResult

Visual Basic (Declaration)

Overloads Public Function Run( _
   ByVal form As RasterImage, _
   ByVal pageRequestCallback As PageRequestCallback, _
   ByVal userData As Object, _
   ByVal categories As List(Of IMasterFormsCategory) _
) As AutoFormsRunResult

Visual Basic (Usage) Copy Code

Visual Basic (Usage)	Copy Code
`Dim instance As AutoFormsEngine Dim form As RasterImage Dim pageRequestCallback As PageRequestCallback Dim userData As Object Dim categories As List(Of IMasterFormsCategory) Dim value As AutoFormsRunResult value = instance.Run(form, pageRequestCallback, userData, categories)`

Dim instance As AutoFormsEngine
Dim form As RasterImage
Dim pageRequestCallback As PageRequestCallback
Dim userData As Object
Dim categories As List(Of IMasterFormsCategory)
Dim value As AutoFormsRunResult
 
value = instance.Run(form, pageRequestCallback, userData, categories)

C#
public AutoFormsRunResult Run( RasterImage form, PageRequestCallback pageRequestCallback, object userData, List<IMasterFormsCategory> categories )

C++/CLI
public: AutoFormsRunResult^ Run( RasterImage form, PageRequestCallback^ pageRequestCallback, Object^ userData, List<IMasterFormsCategory>^ categories )

Parameters

form: The unknown form image.
pageRequestCallback: Page request callback if more form images are needed.
userData: The user defined data that is associated with __Delegates.PageRequestCallback.
categories: List of Master Forms categories to use in comaprison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized, otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Example

Visual Basic Copy Code

Visual Basic	Copy Code
Public Codecs As RasterCodecs Public FormFileName As String Public Sub MyPageRequestCallback(ByVal data As PageRequestCallbackData) data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber) End Sub Public Sub AutoFormRunAutomatic() RasterCodecs.Startup() Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test" Dim codecs_Renamed As RasterCodecs = New RasterCodecs() 'create repository Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root) Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False) ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing) BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead) Dim engineBarcode As BarcodeEngine = New BarcodeEngine() 'create AutoForm Engine Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode) 'set the flag to process the first page only autoEngine.RecognizeFirstPageOnly = True autoEngine.MinimumConfidenceKnownForm = 40 'calculate the minimum confidence recognized form according to the correlation between the master forms in the repository autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm() Codecs = codecs_Renamed FormFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif" 'load the first page of the image Dim form As RasterImage = codecs_Renamed.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1) 'recognize and process the form Dim result As AutoFormsRunResult = autoEngine.Run(form, AddressOf MyPageRequestCallback, Nothing, Nothing) If result Is Nothing Then Return End If End Using RasterCodecs.Shutdown() End Sub

Public Codecs As RasterCodecs

Public FormFileName As String

Public Sub MyPageRequestCallback(ByVal data As PageRequestCallbackData)

   data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber)

End Sub



Public Sub AutoFormRunAutomatic()

   RasterCodecs.Startup()



   Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test"



   Dim codecs_Renamed As RasterCodecs = New RasterCodecs()

   'create repository

   Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root)



   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)

      ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)

      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead)

      Dim engineBarcode As BarcodeEngine = New BarcodeEngine()



      'create AutoForm Engine

      Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode)

      'set the flag to process the first page only

      autoEngine.RecognizeFirstPageOnly = True

      autoEngine.MinimumConfidenceKnownForm = 40

      'calculate the minimum confidence recognized form according to the correlation between the master forms in the repository

      autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm()



      Codecs = codecs_Renamed

      FormFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif"

      'load the first page of the image

      Dim form As RasterImage = codecs_Renamed.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1)

      'recognize and process the form

      Dim result As AutoFormsRunResult = autoEngine.Run(form, AddressOf MyPageRequestCallback, Nothing, Nothing)

      If result Is Nothing Then

         Return

      End If

   End Using

   RasterCodecs.Shutdown()

End Sub

C# Copy Code

C#	Copy Code
public RasterCodecs Codecs; public string FormFileName; public void MyPageRequestCallback(PageRequestCallbackData data) { data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber); } public void AutoFormRunAutomatic() { RasterCodecs.Startup(); string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; RasterCodecs codecs = new RasterCodecs(); //create repository DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) { ocrEngine.Startup(null, null, null, null); BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d \| BarcodeMajorTypeFlags.Barcodes2dRead \| BarcodeMajorTypeFlags.BarcodesDatamatrixRead \| BarcodeMajorTypeFlags.BarcodesPdfRead \| BarcodeMajorTypeFlags.BarcodesQrRead); BarcodeEngine barcodeEngine = new BarcodeEngine(); //create AutoForm Engine AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine); //set the flag to process the first page only autoEngine.RecognizeFirstPageOnly = true; autoEngine.MinimumConfidenceKnownForm = 40; //calculate the minimum confidence recognized form according to the correlation between the master forms in the repository autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm(); Codecs = codecs; FormFileName = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif"; //load the first page of the image RasterImage form = codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1); //recognize and process the form AutoFormsRunResult result = autoEngine.Run(form, MyPageRequestCallback, null,null); if(result == null) return; } RasterCodecs.Shutdown(); }

public RasterCodecs Codecs; 
public string FormFileName; 
public void MyPageRequestCallback(PageRequestCallbackData data) 
{ 
   data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber); 
} 
 
public void AutoFormRunAutomatic() 
{ 
   RasterCodecs.Startup(); 
 
   string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) 
   { 
      ocrEngine.Startup(null, null, null, null); 
      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d | BarcodeMajorTypeFlags.Barcodes2dRead | BarcodeMajorTypeFlags.BarcodesDatamatrixRead | BarcodeMajorTypeFlags.BarcodesPdfRead | BarcodeMajorTypeFlags.BarcodesQrRead); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine); 
      //set the flag to process the first page only 
      autoEngine.RecognizeFirstPageOnly = true; 
      autoEngine.MinimumConfidenceKnownForm = 40; 
      //calculate the minimum confidence recognized form according to the correlation between the master forms in the repository 
      autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm(); 
 
      Codecs = codecs; 
      FormFileName = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif"; 
      //load the first page of the image 
      RasterImage form = codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1); 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(form, MyPageRequestCallback, null,null); 
      if(result == null) 
         return; 
   } 
   RasterCodecs.Shutdown(); 
}

Remarks

This method automatically recognizes the unknown form and process its fields at the same time.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only, if it is false the recognition will be performed over all the form pages.

When RecognizeFirstPageOnly is true and the recognition is performed based on the first page only, form should have at least the first page of the form. So during processing, when more pages are required this method will ask for the required pages one page at a time using the pageRequestCallback. The PageRequestCallbackData.FormPageNumber will have the number of the required page and the user returns the requested page image through the PageRequestCallbackData.Page. For example, in the case where multiple forms are fed to the scanner, you scan the first page and pass it to the form, recognize its form by doing the comparison based on the first page, and then after the form is recognized, the engine will ask for the required pages which you then have to scan for further processing.

If the form is not recognized it will return null. If the Master Form of the form type has no field then AutoFormsRunResult.FormFields will be null.

If form has all form pages you can set pageRequestCallback to null.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Leadtools.Forms.Auto	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 16.5.9.25
Run(RasterImage,PageRequestCallback,Object,Generic List) Method
See Also Example